

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Scripts Tab [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Scripter Window,Scripter Window Scripts Tab,Scripter Window Toolbar,Scripter Window Context Menu,Script,Script Group,Script VBScript,Script JScript,Script JavaScript,Script Local,Script User,Script Create,Script Delete,Script Execute,VBScript,JScript,JavaScript,Toolbar,Toolbar Scripter Window,Context Menu,Context Menu Scripter Window">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Scripts Tab</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="the_scripter_window.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="console_tab.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_UIControl">Scripts </span><span class="f_BodyText">tab is composed of a toolbar, and a view of all scripts according to group.</span></p>
<p class="p_TextIndentedL2"><img src="scripterwindow.png" width="279" height="325" border="0" alt="ScripterWindow"></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_UIControl">Scripts</span><span class="f_BodyText"> tab toolbar provides the following buttons:</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:middle;">
<td valign="middle" width="49" bgcolor="#e3e6ed" style="width:49px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Icon</span></p>
</td>
<td valign="middle" width="957" bgcolor="#e3e6ed" style="width:957px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Use to</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="49" style="width:49px; border: solid 1px #000000;"><p class="p_Tabletext" style="text-align: center;"><img src="newscriptgroup.png" width="24" height="22" border="0" alt="NewScriptGroup"></p>
</td>
<td valign="top" width="957" style="width:957px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Create a new </span><span class="f_Tabletext" style="font-style: italic;">user</span><span class="f_Tabletext"> group. The new group is added to the end of the list in the </span><span class="f_UIControl">Scripter</span><span class="f_Tabletext"> window, with the '</span><span class="f_Tabletext" style="font-style: italic;">New group'</span><span class="f_Tabletext"> text highlighted so that you can type in the group name.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="49" style="width:49px; border: solid 1px #000000;"><p class="p_Tabletext" style="text-align: center;"><img src="createnewscript.png" width="32" height="24" border="0" alt="CreateNewScript"></p>
</td>
<td valign="top" width="957" style="width:957px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Create a new script in the selected </span><span class="f_Tabletext" style="font-style: italic;">user</span><span class="f_Tabletext"> group; displays a short menu of the types of script you can create, namely:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">VBScript (</span><img src="vbscript.png" width="15" height="17" border="0" alt="VBScript"><span class="f_Bulletlist1">)</span></li>
<li><span class="f_Bulletlist1">JScript (</span><img src="jscript.png" width="15" height="17" border="0" alt="Jscript"><span class="f_Bulletlist1">)</span></li>
<li><span class="f_Bulletlist1">JavaScript (</span><img src="javascript.png" width="13" height="16" border="0" alt="Javascript"><span class="f_Bulletlist1">)</span></li>
</ul>
<p class="p_Tabletext"><span class="f_Tabletext">The new script is added to the end of the list in the selected group, with the '</span><span class="f_Tabletext" style="font-style: italic;">New script'</span><span class="f_Tabletext"> text highlighted so that you can type in the script name.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="49" style="width:49px; border: solid 1px #000000;"><p class="p_Tabletext" style="text-align: center;"><img src="refreshscript.png" width="23" height="27" border="0" alt="RefreshScript"></p>
</td>
<td valign="top" width="957" style="width:957px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Refresh the script tree in the </span><span class="f_UIControl">Scripter</span><span class="f_Tabletext"> window.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="49" style="width:49px; border: solid 1px #000000;"><p class="p_Tabletext" style="text-align: center;"><img src="runscript.png" width="21" height="26" border="0" alt="Runscript"></p>
</td>
<td valign="top" width="957" style="width:957px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Compile and execute the selected script. The output from the script is written to the </span><span class="f_UIControl">Script</span><span class="f_Tabletext"> tab of the </span><span class="f_UIControl">Output</span><span class="f_Tabletext"> window, which you display using the </span><span class="f_MenuKeyField">View Script Output</span><span class="f_Tabletext"> <a href="scripts_tab.htm#output">button</a>.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="49" style="width:49px; border: solid 1px #000000;"><p class="p_Tabletext" style="text-align: center;"><img src="stopscript.png" width="26" height="24" border="0" alt="Stopscript"></p>
</td>
<td valign="top" width="957" style="width:957px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Stop an executing script. The icon is disabled if no script is executing.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="49" style="width:49px; border: solid 1px #000000;"><p class="p_Tabletext" style="text-align: center;"><img src="displayoutput.png" width="18" height="26" border="0" alt="DisplayOutput"></p>
</td>
<td valign="top" width="957" style="width:957px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="output"></a><span class="f_Tabletext">Display the </span><span class="f_UIControl">Output</span><span class="f_Tabletext"> window with the results of the most recently executed script displayed in the </span><span class="f_UIControl">Script</span><span class="f_Tabletext"> tab.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="49" style="width:49px; border: solid 1px #000000;"><p class="p_Tabletext" style="text-align: center;"><img src="deletescript.png" width="18" height="27" border="0" alt="DeleteScript"></p>
</td>
<td valign="top" width="957" style="width:957px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Delete a user group </span><span class="f_Tabletext" style="font-style: italic;">script</span><span class="f_Tabletext"> from the model. You cannot use this icon to delete a user </span><span class="f_Tabletext" style="font-style: italic;">group </span><span class="f_Tabletext">(see the <a href="scripts_tab.htm#context">Context Menu</a> section, below), scripts in the Local Scripts group, or a script that is executing.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 4px 2px 4px 2px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote" style="color: #ff0000;">Important:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">The system prompts you to confirm the deletion only if the </span><span class="f_MenuKeyField">Confirm Deletes</span><span class="f_TiporNoteText"> checkbox is selected in the </span><span class="f_UIControl">Project Browser</span><span class="f_TiporNoteText"> panel of the <a href="generalsettings.htm">General page</a> of the </span><span class="f_UIControl">Options</span><span class="f_TiporNoteText"> dialog. If this option is not selected, no prompt is displayed. Script deletion is permanent - scripts cannot be recovered.</span></p>
</td>
</tr>
</table>
</div>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL2"><span class="f_SubHeadingL2">Context Menus</span></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_BodyText" style="font-style: italic;">user</span><span class="f_BodyText"> groups and their scripts also have context menus that provide some or all of the following options:<a name="context"></a></span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_MenuKeyField">Rename group/script</span><span class="f_Bulletlist1"> - to change the name of the selected group or script </span></li>
<li><span class="f_MenuKeyField">Delete group/script</span><span class="f_Bulletlist1"> - to delete the selected group or script</span></li>
<li><span class="f_Bulletlist1" style="font-weight: bold;">New VBScript/JScript/JavaScript</span><span class="f_Bulletlist1"> - add a new script to the selected user group.</span></li>
</ul>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">If you select to delete a user group that contains scripts, the system always prompts you to confirm the action regardless of any system settings for delete operations. Be certain that you intend to delete the group and its scripts before confirming the deletion - deletion of user groups and scripts is permanent.</span></p>
</td>
</tr>
</table>
</div>




            </div>
          </div>
        </div>



</div>


</body>
</html>
